Skip to content

Add description to Schema #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Feb 6, 2020
Merged

Add description to Schema #466

merged 2 commits into from
Feb 6, 2020

Conversation

@IvanGoncharov
Copy link
Member

Fist comment is just put Description section before Schema section.
Changes to review: bd5cdd8

This PR adds description to schema both in SDL and introspection.

tomhoule added a commit to graphql-rust/graphql-client that referenced this pull request Jul 5, 2018
@tomhoule
Adjust the GitHub GQL schema to use spec-compliant descriptions
5f2784e 
It looks like the string literal style for descriptions in the schema language is becoming the standard.

Sources:

- graphql/graphql-spec#466
- https://stackoverflow.com/questions/39962867/how-do-i-add-a-description-to-a-field-in-graphql-schema-language
- https://medium.com/apollo-stack/all-you-need-to-know-about-graphql-js-0-7-921e75dd7fd1#.t9csdknur
leebyron
leebyron reviewed Sep 20, 2018
View reviewed changes
@leebyron
Copy link
Collaborator

leebyron commented Oct 1, 2018

Approved in the last WG meeting

@leebyron leebyron added 🏁 Accepted (RFC 3) RFC Stage 3 (See CONTRIBUTING.md) 📄 Draft (RFC 2) RFC Stage 2 (See CONTRIBUTING.md) and removed RFC 🏁 Accepted (RFC 3) RFC Stage 3 (See CONTRIBUTING.md) labels Oct 2, 2018
@leebyron
Copy link
Collaborator

leebyron commented Oct 2, 2018

@IvanGoncharov I'm going to leave this as Draft instead of Accepted until there are GraphQL.js changes to match!

@michaelstaib michaelstaib mentioned this pull request Oct 4, 2018
Closed
@OlegIlyenko OlegIlyenko mentioned this pull request Oct 6, 2018
Closed
mathroc
mathroc reviewed Nov 26, 2018
View reviewed changes
@michaelstaib michaelstaib mentioned this pull request Nov 10, 2019
Closed
11 tasks
@leebyron
Copy link
Collaborator

@IvanGoncharov I'm going to rebase this PR. I think all looks great here with the only thing holding it back from Stage 3 is support in the reference implementation. Do you want to write a PR for that?

@leebyron
Copy link
Collaborator

Actually you need to grant me permission to your branch/PR unless you'd like to rebase this yourself :)

@IvanGoncharov
Copy link
Member Author

Actually you need to grant me permission to your branch/PR unless you'd like to rebase this yourself :)

I update PR.
It's enabled:
image

But it's probably because my fork is still against facebook/graphql.

Do you want to write a PR for that?

Yes, I will work on it next week.
It should be pretty easy to write.

@lirsacc lirsacc mentioned this pull request Jan 28, 2020
Open
9 tasks
@leebyron
Copy link
Collaborator

@IvanGoncharov any updates on a reference implementation PR for this?

@IvanGoncharov
Copy link
Member Author

@leebyron Working on it at the moment.
It should take just a couple of hours.

IvanGoncharov added a commit to IvanGoncharov/graphql-js that referenced this pull request Jan 30, 2020
@IvanGoncharov
Add support for adding description to schema
74021d5 
Implements graphql/graphql-spec#466
@IvanGoncharov IvanGoncharov mentioned this pull request Jan 30, 2020
Merged
IvanGoncharov added a commit to IvanGoncharov/graphql-js that referenced this pull request Feb 2, 2020
@IvanGoncharov
Add support for adding description to schema
80cec81 
Implements graphql/graphql-spec#466
IvanGoncharov added a commit to IvanGoncharov/graphql-js that referenced this pull request Feb 2, 2020
@IvanGoncharov
Add support for adding description to schema
f24cc3e 
Implements graphql/graphql-spec#466
IvanGoncharov added a commit to graphql/graphql-js that referenced this pull request Feb 3, 2020
@IvanGoncharov
Add support for adding description to schema (#2419)
b883320 
Implements graphql/graphql-spec#466
@leebyron leebyron merged commit 02fd71f into graphql:master Feb 6, 2020
@leebyron leebyron added 🏁 Accepted (RFC 3) RFC Stage 3 (See CONTRIBUTING.md) and removed 📄 Draft (RFC 2) RFC Stage 2 (See CONTRIBUTING.md) labels Feb 6, 2020
@sungam3r sungam3r mentioned this pull request Feb 6, 2020
Merged
maartenvanvliet added a commit to maartenvanvliet/absinthe that referenced this pull request Jan 12, 2021
@maartenvanvliet
Add description to schema
608d38f 
See spec change: graphql/graphql-spec#466
@maartenvanvliet maartenvanvliet mentioned this pull request Jan 12, 2021
Merged
benwilson512 pushed a commit to absinthe-graphql/absinthe that referenced this pull request Jan 12, 2021
@maartenvanvliet
Update builtin types according to spec (#1029)
97a281e 
* Add description to schema

See spec change: graphql/graphql-spec#466

* Update builtin types according to spec

* Render schema description in SDL for SDL/macro schemas
@leebyron leebyron added this to the May2021 milestone Apr 9, 2021
@spawnia spawnia mentioned this pull request Jun 2, 2022
Closed
@spawnia spawnia mentioned this pull request Oct 15, 2022
Open
@benjie benjie mentioned this pull request Sep 28, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leebyron leebyron leebyron left review comments

+1 more reviewer

@mathroc mathroc mathroc left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

🏁 Accepted (RFC 3) RFC Stage 3 (See CONTRIBUTING.md)

Projects

None yet

Milestone

October2021

Development

Successfully merging this pull request may close these issues.

4 participants

@IvanGoncharov @leebyron @mathroc @facebook-github-bot